Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add safe area and document coordinate systems #3890

Merged
merged 45 commits into from
Nov 21, 2024
Merged

Add safe area and document coordinate systems #3890

merged 45 commits into from
Nov 21, 2024

Conversation

madsmtm
Copy link
Member

@madsmtm madsmtm commented Aug 26, 2024 •
edited
Loading

Resolves #2308, by adding Window::safe_area, which describes the area of the surface that is unobstructed by notches, bezels etc. The drawing code in the examples have been updated to draw a star inside the safe area, and the plain background outside of it.

Also renamed Window::inner_position (introduced in #430) to Window::surface_position, and changed it to from screen coordinates to window coordinates, to better align how these coordinate systems work together.

Finally, I've added some SVG images and documentation to describe how these coordinate systems work together. The images should be auto-adjusting to the page theme when viewed on docs.rs. See also #3891, whether we use window coordinates or surface coordinates is currently a bit confusing.

Completing implementation on all platforms is tracked in #3910

Fixes #1122
Fixes #2308
Fixes #3742
Fixes #2066
Fixes #2347
Fixes #2235

@madsmtm madsmtm added DS - android S - api Design and usability S - docs Awareness, docs, examples, etc. DS - ios C - needs discussion Direction must be ironed out labels Aug 26, 2024
@madsmtm madsmtm mentioned this pull request Aug 26, 2024
Open
@madsmtm madsmtm force-pushed the madsmtm/safe-area branch from 7899334 to 67113a7 Compare August 26, 2024 03:17
@madsmtm madsmtm mentioned this pull request Aug 26, 2024
Merged
3 tasks
@dannydulai dannydulai mentioned this pull request Aug 26, 2024
Closed
kchibisov
kchibisov reviewed Aug 26, 2024
View reviewed changes
Copy link
Member

@kchibisov kchibisov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can macOS backend provide safe area when the transparent decorations are used? The ones where the buttons are over the main surface.

src/window.rs Outdated Show resolved Hide resolved
kchibisov
kchibisov reviewed Aug 26, 2024
View reviewed changes
docs/res/coordinate-systems-desktop.svg Outdated Show resolved Hide resolved
src/window.rs Outdated Show resolved Hide resolved
@madsmtm
Copy link
Member Author

madsmtm commented Aug 26, 2024

Can macOS backend provide safe area when the transparent decorations are used? The ones where the buttons are over the main surface.

Didn't even know we had WindowAttributesExtMacOS::with_titlebar_transparent, but yeah, that should be possible.

I was kinda hoping I could define safe_area to not include CSDs, but seems like I'll have to update the docs to include it as well :/.

@kchibisov
Copy link
Member

I was kinda hoping I could define safe_area to not include CSDs, but seems like I'll have to update the docs to include it as well :/.

You just need to y offset, and that's about it from what I can say.

Base automatically changed from madsmtm/inner-to-surface to master September 4, 2024 13:04
@madsmtm
Add safe area and document coordinate systems
98a9914 
Added `Window::safe_area`, which describes the area of the surface that
is unobstructed by notches, bezels etc. The drawing code in the examples
have been updated to draw a star inside the safe area, and the plain
background outside of it.

Also renamed `Window::inner_position` to `Window::surface_position`, and
changed it to from screen coordinates to window coordinates, to better
align how these coordinate systems work together.

Finally, added some SVG images and documentation to describe how all of
this works.
@madsmtm
Copy link
Member Author

madsmtm commented Sep 10, 2024

I have ensured that safe_area includes the title bar when with_titlebar_transparent + with_titlebar_hidden is set on macOS

@madsmtm
Copy link
Member Author

madsmtm commented Nov 4, 2024 •
edited
Loading

I have changed fn safe_area to return the insets (dpi::PhysicalInsets { top, left, bottom, right }) instead, since I belive that will be more forwards-compatible with #3911 and other improvements (discussed on Matrix today to add insets for each type of notch).

I believe the only remaining thing is for @daxpedda to fix the web wrt. scrolling, as I wrote shortly about in #3890 (comment) (if you don't have the time rn, I'm inclined to merge this fairly soon anyhow, and then track the completion of that in #3910).

@madsmtm madsmtm requested review from kchibisov and daxpedda November 4, 2024 14:33
kchibisov
kchibisov requested changes Nov 21, 2024
View reviewed changes
docs/res/coordinate-systems-desktop.svg Outdated Show resolved Hide resolved
examples/window.rs Outdated Show resolved Hide resolved
@madsmtm madsmtm merged commit dbcdb6f into master Nov 21, 2024
56 of 58 checks passed
@madsmtm madsmtm deleted the madsmtm/safe-area branch November 21, 2024 16:37
@madsmtm
Copy link
Member Author

madsmtm commented Nov 21, 2024

I've merged this now, though note that it's only really implemented for macOS and iOS (and Wayland, because there's no protocol for it). Web is implemented, though as noted above, it needs to be changed.

All of this remaining work (fixing the web implementation, implementing properly on the other platforms) is tracked in #3910.

@dannydulai dannydulai mentioned this pull request Nov 25, 2024
Open
@aecsocket aecsocket mentioned this pull request Nov 25, 2024
Open
5 tasks
This was referenced Dec 2, 2024
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kchibisov kchibisov kchibisov approved these changes

@jackpot51 jackpot51 Awaiting requested review from jackpot51 jackpot51 is a code owner

@notgull notgull Awaiting requested review from notgull notgull is a code owner

@MarijnS95 MarijnS95 Awaiting requested review from MarijnS95 MarijnS95 is a code owner

@daxpedda daxpedda Awaiting requested review from daxpedda daxpedda is a code owner

Assignees
No one assigned
Labels
C - needs discussion Direction must be ironed out C - nominated Nominated for discussion in the next meeting DS - android DS - ios DS - web S - api Design and usability S - docs Awareness, docs, examples, etc.
Milestone
Version 0.31.0
5 participants
@madsmtm @kchibisov @nixpulvis @daxpedda @MarijnS95